Flow Message

Flows messages contain a call-to-action button that users can tap. Tapping the button displays your custom Flow.

Parameter	Description
Interactive	Object. The interactive message configuration.
interactive type	Required. Value must be "flow".
interactive action	Refer the table below.

Parameter	Description
name	Required. Value must be "flow".
parameters	Object. mode The Flow can be in either draft or published mode (Default value: published).
flow_message_version	Required. Value must be "3".
flow_id	Required. Unique ID of the Flow.
flow_cta	Required. Text on the CTA button. For example: "Signup". Character limit - 20 characters (no emoji).
flow_action	navigate or data_exchange.

Payload

{
    "recipient_type": "individual",
    "to": "9199XXXXXX",
    "type": "interactive",
    "interactive": {
        "type": "flow",
        "header": {
            "type": "text",
            "text": "hello there"
        },
        "body": {
            "text": "abcd"
        },
        "action": {
            "name": "flow",
            "parameters": {
                "flow_message_version": "3",
                "mode": "draft",
                "flow_token": "16570024150198910848",
                "flow_id": "1",
                "flow_cta": "Book!",
                "flow_action": "data_exchange"
            }
        }
    }
}